跳到主要内容

Java 的 JSON 解析库 Jackson 学习

转载自 史上最全的Jackson框架使用教程

什么是 Jackson

Jackson 是当前用的比较广泛的,用来序列化和反序列化 JSON 的 Java开源框架。Spring MVC的默认 JSON 解析器便是 Jackson。

Jackson优点很多:

  1. Jackson 所依赖的jar包较少,简单易用。
  2. 与其他 Java 的 json 的框架 Gson 等相比,Jackson 解析大的 json 文件速度比较快。
  3. Jackson 运行时占用内存比较低,性能比较好
  4. Jackson 有灵活的 API,可以很容易进行扩展和定制。

添加依赖

Jackson 的核心模块由三部分组成:

  1. jackson-core 核心包,提供基于 ”流模式” 解析的相关 API,它包括 JsonParser 和 JsonGenerator。Jackson 内部实现正是通过高性能的流模式 API 的 JsonGenerator 和 JsonParser 来生成和解析 json。
  2. jackson-annotations 注解包,提供标准注解功能;
  3. jackson-databind 数据绑定包,提供基于 ”对象绑定” 解析的相关 API( ObjectMapper )和 ”树模型” 解析的相关 API(JsonNode);基于 ”对象绑定” 解析的 API 和 ”树模型” 解析的 API 依赖基于 ”流模式” 解析的 API。
<!-- jackson-databind 依赖 jackson-core 和 jackson-annotations,
当添加 jackson-databind 之后, jackson-core 和 jackson-annotations 也随之添加到 Java 项目工程中。

在添加相关依赖包之后,就可以使用 Jackson。 -->
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-databind</artifactId>
<version>2.12.2</version>
</dependency>

快速使用

Jackson 最常用的 API 就是基于"对象绑定" 的 ObjectMapper。下面是一个 ObjectMapper 的使用的简单示例。

准备一个名称为 Person 的 Java 对象:

@Data
public class Person {
// 正常case
private String name;
// 空对象case
private Integer age;
// 日期转换case
private Date date;
// 默认值case
private int height;
}

使用示例:

@Test
public void test1() throws IOException {
ObjectMapper mapper = new ObjectMapper();
// 造数据
Person person = new Person();
person.setName("Tom");
person.setAge(40);
person.setDate(new Date());

System.out.println("序列化");
String jsonString = mapper.writeValueAsString(person);
System.out.println(jsonString);

System.out.println("反序列化");
Person deserializedPerson = mapper.readValue(jsonString, Person.class);
System.out.println(deserializedPerson);
}

打印输出:

序列化
{
"name" : "Tom",
"age" : 40,
"date" : 1594634846647,
"man" : null,
"height" : 0
}
反序列化
JackSonTest.Person(name=Tom, age=40, date=Mon Jul 13 18:07:26 CST 2020, man=null, height=0)

统一配置

在调用 writeValue 或调用 readValue 方法之前,往往需要设置 ObjectMapper 的相关配置信息。这些配置信息应用 java 对象的所有属性上。示例如下:

//在反序列化时忽略在 json 中存在但 Java 对象不存在的属性
mapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
//在序列化时日期格式默认为 yyyy-MM-dd'T'HH:mm:ss.SSSZ
mapper.configure(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS, false);
//在序列化时自定义时间日期格式
mapper.setDateFormat(new SimpleDateFormat("yyyy-MM-dd HH:mm:ss"));
//在序列化时忽略值为 null 的属性
mapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);
//在序列化时忽略值为默认值的属性
mapper.setDefaultPropertyInclusion(JsonInclude.Include.NON_DEFAULT);

更多配置信息可以查看 Jackson 的 DeserializationFeature,SerializationFeature 和 Include。

重新运行单元测试1,打印输出:

序列化
{
"name" : "Tom",
"age" : 40,
"date" : "2020-07-26 18:46:51"
}
反序列化
JackSonTest.Person(name=Tom, age=40, date=Sun Jul 26 18:46:51 CST 2020, height=0)

使用注解

Jackson 根据它的默认方式序列化和反序列化 java 对象,若根据实际需要,灵活的调整它的默认方式,可以使用 Jackson 的注解。常用的注解及用法如下。

// @JsonProperty 用于属性,把属性的名称序列化时转换为另外一个名称。
@JsonProperty("birth_date")
private Date birthDate


// 可用于字段、getter/setter、构造函数参数上,作用相同,都会对相应的字段产生影响。使相应字段不参与序列化和反序列化。
@JsonIgnore


// 该注解是类注解。该注解在Java类和JSON不完全匹配的时候使用。
@JsonIgnoreProperties


// @JsonFormat 用于属性或者方法,把属性的格式序列化时转换成指定的格式。
@JsonFormat(timezone = "GMT+8", pattern = "yyyy-MM-dd HH:mm")
public Date getBirthDate()



// @JsonPropertyOrder 用于类, 和 @JsonProperty 的index属性类似,指定属性在序列化时 json 中的顺序
@JsonPropertyOrder({ "birth_Date", "name" })
public class Person


// @JsonCreator 用于构造方法,和 @JsonProperty 配合使用,适用有参数的构造方法。
@JsonCreator
public Person(@JsonProperty("name")String name) {…}

// @JsonAnySetter 用于属性或者方法,设置未反序列化的属性名和值作为键值存储到 map 中
@JsonAnySetter
public void set(String key, Object value) { map.put(key, value); }

// @JsonAnyGetter 用于方法 ,获取所有未序列化的属性
public Map<String, Object> any() { return map; }


// @JsonNaming 类注解。序列化的时候该注解可将驼峰命名的字段名转换为下划线分隔的小写字母命名方式。
// 反序列化的时候可以将下划线分隔的小写字母转换为驼峰命名的字段名。
@JsonNaming(PropertyNamingStrategy.SnakeCaseStrategy.class)


// @JsonRootName 类注解。需开启 mapper.enable(SerializationFeature.WRAP_ROOT_VALUE),
// 用于序列化时输出带有根属性名称的 JSON 串,形式如 {"root_name":{"id":1,"name":"zhangsan"}}。
// 但不支持该 JSON 串反序列化。
@JsonRootName

使用示例

// 用于类,指定属性在序列化时 json 中的顺序
@JsonPropertyOrder({"date", "user_name"})
// 批量忽略属性,不进行序列化
@JsonIgnoreProperties(value = {"other"})
// 用于序列化与反序列化时的驼峰命名与小写字母命名转换
@JsonNaming(PropertyNamingStrategy.SnakeCaseStrategy.class)
public static class User {
@JsonIgnore
private Map<String, Object> other = new HashMap<>();

// 正常case
@JsonProperty("user_name")
private String userName;
// 空对象case
private Integer age;
@JsonFormat(timezone = "GMT+8", pattern = "yyyy-MM-dd HH:mm:ss")
// 日期转换case
private Date date;
// 默认值case
private int height;

public User() {
}

// 反序列化执行构造方法
@JsonCreator
public User(@JsonProperty("user_name") String userName) {
System.out.println("@JsonCreator 注解使得反序列化自动执行该构造方法 " + userName);
// 反序列化需要手动赋值
this.userName = userName;
}

@JsonAnySetter
public void set(String key, Object value) {
other.put(key, value);
}

@JsonAnyGetter
public Map<String, Object> any() {
return other;
}
// 本文默认省略getter、setter方法
}

日期处理

不同类型的日期类型,JackSon 的处理方式也不同。

普通日期

对于日期类型为 java.util.Calendar, java.util.GregorianCalendar, java.sql.Date, java.util.Date, java.sql.Timestamp,若不指定格式,在 json 文件中将序列化为 long 类型的数据。显然这种默认格式,可读性差,转换格式是必要的。

JackSon 有很多方式转换日期格式。

  • 注解方式,使用 @JsonFormat 注解指定日期格式。
  • ObjectMapper 方式,调用 ObjectMapper 的方法 setDateFormat,将序列化为指定格式的 string 类型的数据。

Local 日期

对于日期类型为 java.time.LocalDate, java.time.LocalDateTime,还需要添加代码 mapper.registerModule(new JavaTimeModule()),同时添加相应的依赖 jar 包。

<dependency> 
<groupId>com.fasterxml.jackson.datatype</groupId>
<artifactId>jackson-datatype-jsr310</artifactId>
<version>2.12.2</version>
</dependency>

使用示例:

@Data
public static class Student {
// 正常case
private String name;
// 日期转换case
private LocalDateTime date;
}

@Test
public void test4() throws IOException {
ObjectMapper mapper = new ObjectMapper();
// 必须添加对LocalDate的支持
mapper.registerModule(JavaTimeModule());
// 造数据
Student student = new Student();
student.setName("Tom");
student.setDate(LocalDateTime.now());
System.out.println("序列化");
String jsonString = mapper.writerWithDefaultPrettyPrinter().writeValueAsString(student);
System.out.println(jsonString);
System.out.println("反序列化");
Student deserializedPerson = mapper.readValue(jsonString, Student.class);
System.out.println(deserializedPerson);
}

private Module JavaTimeModule() {
JavaTimeModule module = new JavaTimeModule();
String DATE_TIME_FORMAT = "yyyy-MM-dd HH:mm:ss";
String DATE_FORMAT = "yyyy-MM-dd";
String TIME_FORMAT = "HH:mm:ss";
module.addSerializer(LocalDateTime.class, new LocalDateTimeSerializer(DateTimeFormatter.ofPattern(DATE_TIME_FORMAT)));
module.addSerializer(LocalDate.class, new LocalDateSerializer(DateTimeFormatter.ofPattern(DATE_FORMAT)));
module.addSerializer(LocalTime.class, new LocalTimeSerializer(DateTimeFormatter.ofPattern((TIME_FORMAT))));
module.addDeserializer(LocalDateTime.class, new LocalDateTimeDeserializer(DateTimeFormatter.ofPattern(DATE_TIME_FORMAT)));
module.addDeserializer(LocalDate.class, new LocalDateDeserializer(DateTimeFormatter.ofPattern(DATE_FORMAT)));
module.addDeserializer(LocalTime.class, new LocalTimeDeserializer(DateTimeFormatter.ofPattern(TIME_FORMAT)));
return module;
}

打印输出:

序列化
{
"name" : "Tom",
"date" : "2020-07-26 23:10:42"
}
反序列化
JackSonTest.Student(name=Tom, date=2020-07-26T23:10:42)

Joda 日期

对于日期类型为 org.joda.time.DateTime,还需要添加代码 mapper.registerModule(new JodaModule()),同时添加相应的依赖 jar 包

<!-- https://mvnrepository.com/artifact/com.fasterxml.jackson.datatype/jackson-datatype-joda -->
<dependency>
<groupId>com.fasterxml.jackson.datatype</groupId>
<artifactId>jackson-datatype-joda</artifactId>
<version>2.12.2</version>
</dependency>

对象集合

Jackson 对泛型反序列化也提供很好的支持。

List

对于 List 类型 ,可以调用 constructCollectionType 方法来序列化,也可以构造 TypeReference 来序列化。

@Test
public void test5() throws IOException {
ObjectMapper mapper = new ObjectMapper();
CollectionType javaType = mapper.getTypeFactory().constructCollectionType(List.class, Person.class);
// 造数据
List<Person> list = new ArrayList<>();
for (int i = 0; i < 3; i++) {
Person person = new Person();
person.setName("Tom");
person.setAge(new Random().nextInt(100));
person.setDate(new Date());
list.add(person);
}
System.out.println("序列化");
String jsonInString = mapper.writerWithDefaultPrettyPrinter().writeValueAsString(list);
System.out.println(jsonInString);
System.out.println("反序列化:使用 javaType");
List<Person> personList = mapper.readValue(jsonInString, javaType);
System.out.println(personList);
System.out.println("反序列化:使用 TypeReference");
List<Person> personList2 = mapper.readValue(jsonInString, new TypeReference<List<Person>>() {
});
System.out.println(personList2);
}

打印输出:

序列化
[ {
"name" : "Tom",
"age" : 33,
"date" : 1595778639371,
"height" : 0
}, {
"name" : "Tom",
"age" : 3,
"date" : 1595778639371,
"height" : 0
}, {
"name" : "Tom",
"age" : 36,
"date" : 1595778639371,
"height" : 0
} ]
反序列化:使用javaType
[JackSonTest.Person(name=Tom, age=33, date=Sun Jul 26 23:50:39 CST 2020, height=0), JackSonTest.Person(name=Tom, age=3, date=Sun Jul 26 23:50:39 CST 2020, height=0), JackSonTest.Person(name=Tom, age=36, date=Sun Jul 26 23:50:39 CST 2020, height=0)]
反序列化:使用TypeReference
[JackSonTest.Person(name=Tom, age=33, date=Sun Jul 26 23:50:39 CST 2020, height=0), JackSonTest.Person(name=Tom, age=3, date=Sun Jul 26 23:50:39 CST 2020, height=0), JackSonTest.Person(name=Tom, age=36, date=Sun Jul 26 23:50:39 CST 2020, height=0)]

Map

对于 map 类型, 与 List 的实现方式相似。

使用示例:

@Test
public void test6() throws IOException {
ObjectMapper mapper = new ObjectMapper();
//第二参数是 map 的 key 的类型,第三参数是 map 的 value 的类型
MapType javaType = mapper.getTypeFactory().constructMapType(HashMap.class, String.class, Person.class);
// 造数据
Map<String, Person> map = new HashMap<>();
for (int i = 0; i < 3; i++) {
Person person = new Person();
person.setName("Tom");
person.setAge(new Random().nextInt(100));
person.setDate(new Date());
map.put("key" + i, person);
}
System.out.println("序列化");
String jsonInString = mapper.writerWithDefaultPrettyPrinter().writeValueAsString(map);
System.out.println(jsonInString);
System.out.println("反序列化: 使用 javaType");
Map<String, Person> personMap = mapper.readValue(jsonInString, javaType);
System.out.println(personMap);
System.out.println("反序列化: 使用 TypeReference");
Map<String, Person> personMap2 = mapper.readValue(jsonInString, new TypeReference<Map<String, Person>>() {
});
System.out.println(personMap2);
}

打印输出:

序列化
{
"key1" : {
"name" : "Tom",
"age" : 95,
"date" : 1595778740606,
"height" : 0
},
"key2" : {
"name" : "Tom",
"age" : 27,
"date" : 1595778740606,
"height" : 0
},
"key0" : {
"name" : "Tom",
"age" : 98,
"date" : 1595778740606,
"height" : 0
}
}
反序列化: 使用 javaType
{key1=JackSonTest.Person(name=Tom, age=95, date=Sun Jul 26 23:52:20 CST 2020, height=0), key2=JackSonTest.Person(name=Tom, age=27, date=Sun Jul 26 23:52:20 CST 2020, height=0), key0=JackSonTest.Person(name=Tom, age=98, date=Sun Jul 26 23:52:20 CST 2020, height=0)}
反序列化: 使用 TypeReference
{key1=JackSonTest.Person(name=Tom, age=95, date=Sun Jul 26 23:52:20 CST 2020, height=0), key2=JackSonTest.Person(name=Tom, age=27, date=Sun Jul 26 23:52:20 CST 2020, height=0), key0=JackSonTest.Person(name=Tom, age=98, date=Sun Jul 26 23:52:20 CST 2020, height=0)}

属性可视化

JackSon 默认不是所有的属性都可以被序列化和反序列化。默认的属性可视化的规则如下:

  • 若该属性修饰符是 public,该属性可序列化和反序列化。
  • 若属性的修饰符不是 public,但是它的 getter 方法和 setter 方法是 public,该属性可序列化和反序列化。因为 getter 方法用于序列化, 而 setter 方法用于反序列化。
  • 若属性只有 public 的 setter 方法,而无 public 的 getter 方 法,该属性只能用于反序列化。

若想更改默认的属性可视化的规则,需要调用 ObjectMapper 的方法 setVisibility。

下面的示例使修饰符为 protected 的属性 name 也可以序列化和反序列化。

public static class People {
public int age;
protected String name;
}

@Test
public void test7() throws IOException {
ObjectMapper mapper = new ObjectMapper();
// PropertyAccessor 支持的类型有 ALL,CREATOR,FIELD,GETTER,IS_GETTER,NONE,SETTER
// Visibility 支持的类型有 ANY,DEFAULT,NON_PRIVATE,NONE,PROTECTED_AND_PUBLIC,PUBLIC_ONLY
mapper.setVisibility(PropertyAccessor.FIELD, JsonAutoDetect.Visibility.ANY);
// 造数据
People people = new People();
people.name = "Tom";
people.age = 40;
System.out.println("序列化");
String jsonString = mapper.writerWithDefaultPrettyPrinter().writeValueAsString(people);
System.out.println(jsonString);
System.out.println("反序列化");
People deserializedPerson = mapper.readValue(jsonString, People.class);
System.out.println(deserializedPerson);
}

打印输出:

序列化
{
"age" : 40,
"name" : "Tom"
}
反序列化
JackSonTest.People(age=40, name=Tom)

属性过滤

在将 Java 对象序列化为 json 时 ,有些属性需要过滤掉,不显示在 json 中 ,除了使用 @JsonIgnore 过滤单个属性或用 @JsonIgnoreProperties 过滤多个属性之外, Jackson 还有通过代码控制的方式。

@JsonFilter("myFilter")
public interface MyFilter {
}

@Test
public void test8() throws JsonProcessingException {
ObjectMapper mapper = new ObjectMapper();
//设置 addMixIn
mapper.addMixIn(Person.class, MyFilter.class);
//调用 SimpleBeanPropertyFilter 的 serializeAllExcept 方法
SimpleBeanPropertyFilter newFilter = SimpleBeanPropertyFilter.serializeAllExcept("age");
//或重写 SimpleBeanPropertyFilter 的 serializeAsField 方法
SimpleBeanPropertyFilter newFilter2 = new SimpleBeanPropertyFilter() {
@Override
public void serializeAsField(Object pojo, JsonGenerator jgen,
SerializerProvider provider, PropertyWriter writer)
throws Exception {
if (!writer.getName().equals("age")) {
writer.serializeAsField(pojo, jgen, provider);
}
}
};
//设置 FilterProvider
FilterProvider filterProvider = new SimpleFilterProvider().addFilter("myFilter", newFilter);
// 造数据
Person person = new Person();
person.setName("Tom");
person.setAge(40); // 该属性将被忽略
person.setDate(new Date());
// 序列化
String jsonString = mapper.setFilterProvider(filterProvider).writeValueAsString(person);
System.out.println(jsonString);
}

打印输出:

{"name":"Tom","date":1595780842754}

自定义序列化类

当 Jackson 默认序列化和反序列化的类不能满足实际需要,可以自定义新的序列化和反序列化的类。

自定义序列化类

自定义的序列化类需要直接或间接继承 StdSerializer 或 JsonSerializer,同时需要利用 JsonGenerator 生成 json,重写方法 serialize,示例如下:

public static class CustomSerializer extends StdSerializer<Person> {
protected CustomSerializer() {
super(Person.class);
}

@Override
public void serialize(Person person, JsonGenerator jgen, SerializerProvider provider) throws IOException {
jgen.writeStartObject();
jgen.writeNumberField("age", person.getAge());
jgen.writeStringField("name", person.getName());
jgen.writeStringField("msg", "已被自定义序列化");
jgen.writeEndObject();
}
}

JsonGenerator 有多种 write 方法以支持生成复杂的类型的 json,比如 writeArray,writeTree 等 。若想单独创建 JsonGenerator,可以通过 JsonFactory() 的 createGenerator。

自定义反序列化类

自定义的反序列化类需要直接或间接继承 StdDeserializer 或 StdDeserializer,同时需要利用 JsonParser 读取 json,重写方法 deserialize,示例如下:

public static class CustomDeserializer extends StdDeserializer<Person> {
protected CustomDeserializer() {
super(Person.class);
}

@Override
public Person deserialize(JsonParser jp, DeserializationContext ctxt)
throws IOException, JsonProcessingException {
JsonNode node = jp.getCodec().readTree(jp);
Person person = new Person();
int age = (Integer) ((IntNode) node.get("age")).numberValue();
String name = node.get("name").asText();
person.setAge(age);
person.setName(name);
return person;
}
}

JsonParser 提供很多方法来读取 json 信息, 如 isClosed(), nextToken(), getValueAsString() 等。若想单独创建 JsonParser,可以通过 JsonFactory() 的 createParser。

注册当前 Module

定义好自定义序列化类和自定义反序列化类,若想在程序中调用它们,还需要注册到 ObjectMapper 的 Module,示例如下:

@Test
public void test9() throws IOException {
ObjectMapper mapper = new ObjectMapper();
// 生成 module
SimpleModule module = new SimpleModule("myModule");
module.addSerializer(new CustomSerializer());
module.addDeserializer(Person.class, new CustomDeserializer());
// 注册 module
mapper.registerModule(module);
// 造数据
Person person = new Person();
person.setName("Tom");
person.setAge(40);
person.setDate(new Date());
System.out.println("序列化");
String jsonString = mapper.writerWithDefaultPrettyPrinter().writeValueAsString(person);
System.out.println(jsonString);
System.out.println("反序列化");
Person deserializedPerson = mapper.readValue(jsonString, Person.class);
System.out.println(deserializedPerson);
}

或者也可通过注解方式加在 java 对象的属性,方法或类上面来调用它们:

@JsonSerialize(using = CustomSerializer.class)
//
@JsonDeserialize(using = CustomDeserializer.class)

JsonNode 解析 json 数据

Jackson 也提供了树模型(tree model)来生成和解析 json。(其实就是类似 Map的东西)

若想修改或访问 json 部分属性,树模型是不错的选择。

树模型由 JsonNode 节点组成。程序中常常使用 ObjectNode,ObjectNode 继承于 JsonNode,示例如下:

@Test
public void test10() throws IOException {
ObjectMapper mapper = new ObjectMapper();
//构建 ObjectNode
ObjectNode personNode = mapper.createObjectNode();
//添加/更改属性
personNode.put("name", "Tom");
personNode.put("age", 40);
ObjectNode addressNode = mapper.createObjectNode();
addressNode.put("zip", "000000");
addressNode.put("street", "Road NanJing");
//设置子节点
personNode.set("address", addressNode);
System.out.println("构建 ObjectNode:\n" + personNode.toString());
//通过 path 查找节点
JsonNode searchNode = personNode.path("name");
System.out.println("查找子节点 name:\n" + searchNode.asText());
//删除属性
((ObjectNode) personNode).remove("address");
System.out.println("删除后的 ObjectNode:\n" + personNode.toString());
//读取 json
JsonNode rootNode = mapper.readTree(personNode.toString());
System.out.println("Json 转 JsonNode:\n" + rootNode);
//JsonNode 转换成 java 对象
Person person = mapper.treeToValue(personNode, Person.class);
System.out.println("JsonNode 转对象:\n" + person);
//java 对象转换成 JsonNode
JsonNode node = mapper.valueToTree(person);
System.out.println("对象转 JsonNode:\n" + node);
}

打印输出:

构建 ObjectNode:
{"name":"Tom","age":40,"address":{"zip":"000000","street":"Road NanJing"}}
查找子节点 name:
Tom
删除后的 ObjectNode:
{"name":"Tom","age":40}
Json 转 JsonNode:
{"name":"Tom","age":40}
JsonNode 转对象:
JackSonTest.Person(name=Tom, age=40, date=null, height=0)
对象转 JsonNode:
{"name":"Tom","age":40,"date":null,"height":0}

注意:

String body = result.getResponse().getContentAsString();
// 注意:最后这里要用 asText 不要用 toString,否则结果是有 " " 引号的
String jwt = objectMapper.readTree(body).get("jwt").asText();
System.out.println("===============" + jwt);